fix: categorize all expense switch is not disabled #39036

tienifr · 2024-03-27T08:20:36Z

Details

Fixed Issues

$ #37508
PROPOSAL: #37508 (comment)

Tests

Precondition:

User is admin of Collect workspace that has categories.
All categories are disabled in the Collect workspace.

Go to workspace settings.
Select the Collect workspace.
Click on Categories.
Disable every categories
Click on Settings.
Verify that "Members must categorize all spend" should be turned off and disabled
Enable at least one category > Settings
Verify that "Members must categorize all spend" can be toggled.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Precondition:

User is admin of Collect workspace that has categories.
All categories are disabled in the Collect workspace.

Go to workspace settings.
Select the Collect workspace.
Click on Categories.
Disable every categories
Click on Settings.
Verify that "Members must categorize all spend" should be turned off and disabled
Enable at least one category > Settings
Verify that "Members must categorize all spend" can be toggled.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-03-29.at.11.29.40.mov

Android: mWeb Chrome

Screen.Recording.2024-03-29.at.11.43.00.mov

iOS: Native

Screen.Recording.2024-03-29.at.11.49.53.mov

iOS: mWeb Safari

Screen.Recording.2024-03-29.at.11.45.30.mov

MacOS: Chrome / Safari

Screen.Recording.2024-03-29.at.11.23.43.mov

MacOS: Desktop

Screen.Recording.2024-03-29.at.11.25.27.mov

tienifr · 2024-03-27T12:16:27Z

Currently, we check whether there's any enabled category remaining after the update, if no enabled category remaining, set areCategoriesEnabled as false. That leads to the "Hmmm It 's not here" screen display(see below video) because of this logic:

App/src/pages/workspace/FeatureEnabledAccessOrNotFoundWrapper.tsx

Line 38 in 69a2849

const shouldShowNotFoundPage = isEmptyObject(props.policy) || !props.policy?.id || !PolicyUtils.isPolicyFeatureEnabled(props.policy, props.featureName);
So I think we should navigate user to another screen in this case (for example, more-feature screen). What do you think @getusha @luacmartins ?

Screen.Recording.2024-03-27.at.19.10.58.mov

melvin-bot · 2024-03-27T12:16:55Z

@getusha Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

luacmartins · 2024-03-27T15:58:53Z

@tienifr yes, I think navigating to the more features page makes sense in this case. cc @JmillsExpensify

src/libs/actions/Policy.ts

getusha · 2024-03-27T16:59:48Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2024-04-03.at.6.31.00.in.the.evening.mov

Android: mWeb Chrome

Screen.Recording.2024-04-02.at.10.09.04.at.night.mov

iOS: Native

Screen.Recording.2024-04-02.at.10.32.24.at.night.mov

iOS: mWeb Safari

Screen.Recording.2024-04-02.at.10.28.15.at.night.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-02.at.9.20.24.at.night.mov

MacOS: Desktop

Screen.Recording.2024-04-03.at.6.37.24.in.the.evening.mov

getusha · 2024-03-27T20:16:18Z

Currently, we check whether there's any enabled category remaining after the update, if no enabled category remaining, set areCategoriesEnabled as false. That leads to the "Hmmm It 's not here" screen display(see below video) because of this logic:

I think we should fix this behavior, it doesn't seem to be something we can ignore. if it is not possible lets use other alternatives.

Screen.Recording.2024-03-27.at.11.13.37.at.night.mov

luacmartins · 2024-03-27T23:35:01Z

Yea, let's navigate the user to the more features page

getusha · 2024-03-28T07:58:30Z

Yea, let's navigate the user to the more features page

@luacmartins Is this ideal? i don't see the need to navigate away to that page. it'll definitely be logged as a bug.

tienifr · 2024-03-28T08:41:27Z

@getusha @luacmartins I resolved all the comments

luacmartins · 2024-03-28T14:59:40Z

cc @JmillsExpensify what do you think? What should happen when the user disables the last enabled category? Currently we also turn off the categories features (since that's what we do in OldDot), but then they see the not found page.

luacmartins

One minor comment and we're also pending confirmation on the desired behavior

luacmartins · 2024-03-28T15:02:41Z

src/libs/actions/Policy.ts

+            return acc;
+        }, {}),
+    };
+    const shouldTurnOffCategoriesEnabled = !OptionsListUtils.hasEnabledOptions({...policyCategories, ...optimisticPolicyCategoriesData});


Suggested change

const shouldTurnOffCategoriesEnabled = !OptionsListUtils.hasEnabledOptions({...policyCategories, ...optimisticPolicyCategoriesData});

const shouldDisableRequiresCategory = !OptionsListUtils.hasEnabledOptions({...policyCategories, ...optimisticPolicyCategoriesData});

luacmartins · 2024-03-28T15:50:26Z

@tienifr @getusha we discussed this internally and the toggle that's switched off in OldDot is All members must categorize expenses. OldDot does not have a feature toggle for the whole Categories page, so we should not disable areCategoriesEnabled and just disable requiresCategories instead

src/libs/actions/Policy.ts

tienifr · 2024-03-29T03:13:33Z

@luacmartins I resolved all your comments

tienifr · 2024-03-29T04:55:42Z

Also, I updated screenshots and test steps

luacmartins

@getusha all yours. Let's get this one merged!

luacmartins · 2024-04-02T16:18:02Z

@getusha did @tienifr's last comment address your concern?

luacmartins

Just one small comment.

luacmartins · 2024-04-02T16:39:36Z

src/pages/workspace/categories/WorkspaceCategoriesSettingsPage.tsx

    const styles = useThemeStyles();
    const {translate} = useLocalize();

    const updateWorkspaceRequiresCategory = (value: boolean) => {
        setWorkspaceRequiresCategory(route.params.policyID, value);
    };

+    const policyCategoriesCount = OptionsListUtils.getEnabledCategoriesCount(policyCategories ?? {});


Could we use OptionsListUtils.hasEnabledOptions too? I think that might be slightly better since it short-circuits the loop if it finds an enabled option.

I updated to use OptionsListUtils.hasEnabledOptions instead

getusha · 2024-04-02T16:49:58Z

@getusha did @tienifr's last comment address your concern?

yeah, i think it's fine 👍

luacmartins · 2024-04-02T16:59:53Z

Nice! Thanks for updating that! @getusha are you available to continue your review? Let's get this one merged!

getusha · 2024-04-02T17:08:22Z

@getusha are you available to continue your review?

Yes 🙂

getusha · 2024-04-02T17:33:57Z

Go to workspace settings.
Select the Collect workspace.
Click on Categories.
Disable every categories
Click on Settings.
Verify that "Members must categorize all spend" should be turned off and disabled
Enable at least one category > Settings
Verify that "Members must categorize all spend" can be toggled.

@tienifr QA steps is not clear, can you update it to something like this?

tienifr · 2024-04-02T17:48:49Z

@getusha I updated test steps

getusha · 2024-04-02T18:19:43Z

Members must categorize all spend is enabled without any enabled categories

Enable at least 1 category
Settings > Enable Members must categorize all spend
Go offline
Disable all categories > Settings
Go online

Screen.Recording.2024-04-02.at.8.57.11.in.the.evening.mov

@luacmartins It looks like a backend issue

luacmartins · 2024-04-02T18:24:55Z

I can work on a fix for that in the backend. Let's not block this PR on that

getusha · 2024-04-02T18:57:36Z

src/libs/actions/Policy.ts

@@ -2938,6 +2941,37 @@ function setWorkspaceCategoryEnabled(policyID: string, categoriesToUpdate: Recor
            },
        ],
    };
+    if (shouldDisableRequiresCategory) {


can we do the same for deleteWorkspaceCategories?

App/src/libs/actions/Policy.ts

Line 3439 in 5986481

function deleteWorkspaceCategories(policyID: string, categoryNamesToDelete: string[]) {

Screen.Recording.2024-04-02.at.9.55.11.at.night.mov

I updated to do the same when deleting category

Nice catch!

luacmartins · 2024-04-03T14:48:06Z

src/libs/OptionsListUtils.ts

@@ -826,8 +826,8 @@ function getSearchValueForPhoneOrEmail(searchTerm: string) {
 /**
 * Verifies that there is at least one enabled option
 */
-function hasEnabledOptions(options: PolicyCategories | PolicyTag[]): boolean {
-    return Object.values(options).some((option) => option.enabled);
+function hasEnabledOptions(options: PolicyCategories | PolicyTag[], shouldContainPendingDeleteOption = true): boolean {


Why do we need shouldContainPendingDeleteOption? Don't we always want to include those?

If we do not use shouldContainPendingDeleteOption: Assume that all our categories are enabled. If we go offline and then delete all our categories, the hasEnabledOptions still returns true, which leads to the user still can toggle the "Required categories" switch

Correct, but that's what I meant. Don't we always want to filter our pending delete categories when checking for hasEnabledOptions?

Correct, but that's what I meant. Don't we always want to filter our pending delete categories when checking for hasEnabledOptions?

+1

I updated based on this suggestion

OSBotify · 2024-04-03T16:33:13Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

kavimuru · 2024-04-04T23:13:33Z

Bug #37508 still reproducible. After disabling all the categories, "Members must categorize all spend" is not disabled and couldn't toggle.
Reproducible in all the platforms.

https://platform.applause.com/services/links/v1/external/50eee7bf4427b4065706b53d752a68e324525759f71ebf78ea9eb88beb74276b
https://platform.applause.com/services/links/v1/external/6c4175e203d81c044f05efb9c35004a75fa72fd1476491d0ad0169fde72a1992"
https://platform.applause.com/services/links/v1/external/068923ed2dcb49f9eb4d98facbf8e2df78bfaa9e2b43a700423b7c8e779169cd
https://platform.applause.com/services/links/v1/external/083b31d47541b82d382eb1cfc378c701062ef54dc723e969ff3c070276cca32f
https://platform.applause.com/services/links/v1/external/bf3602da3b2687a47c14555c65462aaa6949b5876b60cc85932f6f965fbb4258
https://platform.applause.com/services/links/v1/external/4862d7eb39f0634a3e82564e30137e1a796be977f2e3b8505dd20ebf2c8ba0f6

OSBotify · 2024-04-08T10:55:44Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.60-13 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

fix categorize all expense switch is not disabled

299e1e6

tienifr marked this pull request as ready for review March 27, 2024 12:16

tienifr requested a review from a team as a code owner March 27, 2024 12:16

melvin-bot bot removed the request for review from a team March 27, 2024 12:16

melvin-bot bot requested a review from getusha March 27, 2024 12:16

tienifr changed the title ~~fix categorize all expense switch is not disabled~~ fix: categorize all expense switch is not disabled Mar 27, 2024

luacmartins self-requested a review March 27, 2024 15:57

luacmartins requested changes Mar 27, 2024

View reviewed changes

src/libs/actions/Policy.ts Show resolved Hide resolved

src/libs/actions/Policy.ts Show resolved Hide resolved

src/libs/actions/Policy.ts Outdated Show resolved Hide resolved

tienifr added 3 commits March 28, 2024 11:51

fix revert areCategories if failed

67322e1

fix navigate user to more feature page

547f69b

fix add pendingFields

3874d9c

fix goback before navigate to more feature screen

830640c

luacmartins self-requested a review March 28, 2024 15:01

luacmartins reviewed Mar 28, 2024

View reviewed changes

luacmartins requested changes Mar 28, 2024

View reviewed changes

tienifr added 2 commits March 29, 2024 09:33

fix only turn off require category

85cd494

fix using policy?.requiresCategory

7520ddf

luacmartins previously approved these changes Mar 29, 2024

View reviewed changes

luacmartins reviewed Apr 2, 2024

View reviewed changes

fix use hasEnabledOptions insteads of getEnabledCategoriesCount

a19beb1

luacmartins previously approved these changes Apr 2, 2024

View reviewed changes

fix merge main

6367292

getusha reviewed Apr 2, 2024

View reviewed changes

tienifr added 2 commits April 3, 2024 13:20

fix merge main

9eaf74a

fix disable require category switch once remove any category

6b05057

tienifr dismissed luacmartins’s stale review via 6b05057 April 3, 2024 07:23

luacmartins previously approved these changes Apr 3, 2024

View reviewed changes

luacmartins requested a review from getusha April 3, 2024 15:31

fix remove shouldContainPendingDeleteOption

a45c9a9

tienifr dismissed luacmartins’s stale review via a45c9a9 April 3, 2024 15:53

getusha approved these changes Apr 3, 2024

View reviewed changes

melvin-bot bot requested a review from luacmartins April 3, 2024 15:55

luacmartins approved these changes Apr 3, 2024

View reviewed changes

luacmartins merged commit 838206f into Expensify:main Apr 3, 2024
18 checks passed

github-actions bot mentioned this pull request Apr 4, 2024

[INCORRECT] (used to be a checklist but was incorrectly triggered) #39573

Closed

44 tasks

mountiny mentioned this pull request Apr 4, 2024

Deploy Checklist: New Expensify 2024-04-04 #39588

Closed

48 tasks

melvin-bot bot mentioned this pull request Apr 8, 2024

[HOLD for payment 2024-04-15] [$500] [Simplified Collect][Categories] - "Categorize all expense" switch is not disabled when all categories are disabled #37508

Closed

6 tasks

	const shouldTurnOffCategoriesEnabled = !OptionsListUtils.hasEnabledOptions({...policyCategories, ...optimisticPolicyCategoriesData});
	const shouldDisableRequiresCategory = !OptionsListUtils.hasEnabledOptions({...policyCategories, ...optimisticPolicyCategoriesData});

fix: categorize all expense switch is not disabled #39036

fix: categorize all expense switch is not disabled #39036

Conversation

tienifr commented Mar 27, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

tienifr commented Mar 27, 2024 • edited Loading

melvin-bot bot commented Mar 27, 2024

luacmartins commented Mar 27, 2024

getusha commented Mar 27, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

getusha commented Mar 27, 2024

luacmartins commented Mar 27, 2024

getusha commented Mar 28, 2024 • edited Loading

tienifr commented Mar 28, 2024

luacmartins commented Mar 28, 2024 • edited Loading

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins Mar 28, 2024 • edited Loading

Choose a reason for hiding this comment

luacmartins commented Mar 28, 2024

tienifr commented Mar 29, 2024

tienifr commented Mar 29, 2024

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins commented Apr 2, 2024

luacmartins left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

getusha commented Apr 2, 2024

luacmartins commented Apr 2, 2024

getusha commented Apr 2, 2024

getusha commented Apr 2, 2024

tienifr commented Apr 2, 2024

getusha commented Apr 2, 2024

luacmartins commented Apr 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tienifr Apr 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Apr 3, 2024

kavimuru commented Apr 4, 2024

OSBotify commented Apr 8, 2024

tienifr commented Mar 27, 2024 •

edited

Loading

tienifr commented Mar 27, 2024 •

edited

Loading

getusha commented Mar 27, 2024 •

edited

Loading

getusha commented Mar 28, 2024 •

edited

Loading

luacmartins commented Mar 28, 2024 •

edited

Loading

luacmartins Mar 28, 2024 •

edited

Loading

tienifr Apr 3, 2024 •

edited

Loading